iT邦幫忙

1

Github-Action: 自動生成多語言版本的 README.md

  • 分享至 

  • xImage
  •  

介紹

  • 之前有發布一篇相關文章,但當時並沒有將 Action 發佈到github marketplace,導致要使用該工具需下載 shell script (現在只要在 yaml 檔案寫上一個 job 即可)。
  • 專案提供了一個 Github Action 自動翻譯功能
  • 我們都知道寫文檔費時費力,但是現在有一個解決方案可以讓你節省一半的時間. 這就是我們的action-translate-readme
  • 有了這個工具,你可以自動翻譯README.md文件,不僅可以翻譯,還可以識別Markdown內聯代碼、表情、代碼塊、HTML標籤和鏈接等各種元素
  • 其運行原理是通過Github Actions實現自動化,只需要推送更新的README文件,翻譯後的README(zh或en)文件即可自動更新(自動提交)

方法

  • 於自己的專案 ./.github/workflow 新增一個 yaml 檔案,即可啟動 Action:
    https://ithelp.ithome.com.tw/upload/images/20230515/20158150Btbw0tF1Xo.png
  • 修改 README.md 時,並 push 至專案上
    https://ithelp.ithome.com.tw/upload/images/20230515/20158150r8fWHTBFAR.png
  • Github Action 偵測 README.md 被改動,透過 Action Bot 自動翻譯與生成中文文檔案 - README.zh-TW.md
    https://ithelp.ithome.com.tw/upload/images/20230515/20158150mJm0YUAIzA.png

目的

相信很多專案開發者,往往會建立多語言版本的說明檔 (README.md)。

雖然現在使用瀏覽器具有強大翻譯功能,但是一個 Github 專案上有不同語言的說明檔,絕對會讓使用者觀看得更方便 !
(本人分析自己專案 insight trafic 時,發現中文使用者都會直接觀看中文說明檔)

結語

  • 目前該專案還有很多不足地方,翻譯 Markdown 語言碰上了許多問題,尚有些許地方待更新
  • 望各位大佬若覺得哪裡要改進,歡迎提出與討論

更新

  • 使用 g4f 免費調用 openai api 進行翻譯,翻譯效果好
  • 除了繁體中文版,可以自行在.yml定義想要的語言版本,例如: en,zh-TW,zh-CN,French

圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言